docs: callinterface doc comments#16396
Merged
iAmMichaelConnor merged 1 commit intonextfrom Aug 29, 2025
Merged
Conversation
✅ Deploy Preview for barretenberg ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
benesjan
approved these changes
Aug 29, 2025
Contributor
benesjan
left a comment
benesjan
left a comment
There was a problem hiding this comment.
Very nice and thorough. Feel free to merge once you address my comments
| /// information, such as: | ||
| /// - Calling an internal public function. | ||
| /// - Calling a public function and not setting msg_sender to Option::none | ||
| /// (feature not built yet - see github). |
Contributor
There was a problem hiding this comment.
do we have an issue for this? Would make sense to link it here
Contributor
Author
There was a problem hiding this comment.
Ah, yes, I've linked the pending PR
| /// Makes a _read-only_ call to this private function. | ||
| /// | ||
| /// This is similar to Solidity's `staticcall`. The called function | ||
| /// cannot modify state, emit L2->L2 messages, nor emit events. Any nested |
Contributor
There was a problem hiding this comment.
Suggested change
| /// cannot modify state, emit L2->L2 messages, nor emit events. Any nested | |
| /// cannot modify state, emit L2->L1 messages, nor emit events. Any nested |
| } | ||
| } | ||
|
|
||
| /// Enqueues a read-only call to this private function. |
Contributor
There was a problem hiding this comment.
In PrivateCallInterface::view you have "Makes a read-only call to this private function."
Why do you say "enqueues" here? It's in private so the functions are directly called.
Contributor
Author
There was a problem hiding this comment.
Ah, good catch. That's a typo by me
| /// Enqueues a read-only call to this public function. | ||
| /// | ||
| /// This is similar to Solidity's `staticcall`. The called function | ||
| /// cannot modify state, emit L2->L2 messages, nor emit events. Any nested |
Contributor
There was a problem hiding this comment.
Suggested change
| /// cannot modify state, emit L2->L2 messages, nor emit events. Any nested | |
| /// cannot modify state, emit L2->L1 messages, nor emit events. Any nested |
iAmMichaelConnor
force-pushed
the
mc/call-interface-doc-comments
branch
from
70615de to
6947971
Compare
iAmMichaelConnor
force-pushed
the
mc/call-interface-doc-comments
branch
from
6947971 to
b6d4869
Compare
ludamad
pushed a commit
that referenced
this pull request
Dec 16, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I didn't know about the call_interfaces.nr file when I documented the "call" functions in the PrivateContext and PublicContext. I've copied-over (with some very minor tweaks) the already-approved-and-merged doc comments for function calls from PrivateContext/PublicContext into
call_interfaces.nr, because most devs will be exposed to those wrapper functions, rather than the functions in the context.No code changes; just comments.